Description
This index method provides an array of CoreOne Lims Accessions that match any search criteria provided.
Request (LimsAccessionsIndex)
Below are the required parameters to successfully return an array of CoreOne Lims Accessions that fall within a specified time frame. If any parameter is omitted an error message will be displayed alerting the user.
Request Body Parameters
| Name | Description | Data Type | ||
|---|---|---|---|---|
| token | This is a 40-character hexadecimal string.
| xml:string | ||
| search | This is a space-delimited list of search terms which will be used to filter your search results. If multiple search terms are supplied the search is additive in nature. It is not case sensitive. If omitted, the search defaults to an empty string. | xml:string | ||
| page | Results from this method are paginated; this parameter specifies the page number you wish returned. If omitted, the default page number is 1. | xml:int | ||
| limit | Results from this method are paginated; this parameter specifies the number of items per page that are returned. If omitted, the default limit is 15. This is to prevent mass data extraction. | xml:int | ||
| start_date | This is used as the start date of a time frame to return Lims Accessions that where created after this specified date. It is a required parameter and must be in format YYYY-MM-DD. | xml:date | ||
| end_date | This is used as the end date of a time frame to return Lims Accessions that where created before this specified date. It is a required parameter and must be in format YYYY-MM-DD. | xml:date |
Response (LimsAccessionsIndex_response)
This will return a list of CoreOne Lims Accessions along with a summary of each Lims Accession's details.
 |
To get more comprehensive details on a specific CoreOne Lims Accession use the LimsAccessionsShow(Method). |
Response Body Parameters
| Name | Description | Data Type |
|---|---|---|
| lims_accession | This is an array which shows the details for each CoreOne Lims Accession returned. | ws_lims_accession |
Remarks
See Also